use File.pathSeparator for classpath in genDocs #4182
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dottybot
reviewed
Mar 25, 2018
|
There are other uses of ":" in Build.scala, would you mind fixing them too? |
robstoll
force-pushed
the
genDocs-path-separator
branch
from
e9b5a97 to
51b9042
Compare
|
@smarter Might be that the following should be fixed as well but could be done in a separate pull request if needed: |
robstoll
force-pushed
the
genDocs-path-separator
branch
6 times, most recently
from
4236369 to
4e1042d
Compare
|
An improvement would be to reduce code duplication between genDocs and dottydoc, lines 366-370 and 388-391 are the same. This is my first encounter with sbt and I don't know how to move code into an own function without encountering the error that I cannot access |
Probably something like this: diff --git a/project/Build.scala b/project/Build.scala
index 4d7f1ad1d..df0b5e13d 100644
--- a/project/Build.scala
+++ b/project/Build.scala
@@ -345,6 +345,13 @@ object Build {
javacOptions in (Compile, doc) --= Seq("-Xlint:unchecked", "-Xlint:deprecation")
)
+ private lazy val dottydocClasspath = Def.task {
+ val dottyLib = (packageAll in `dotty-compiler`).value("dotty-library")
+ val dottyInterfaces = (packageAll in `dotty-compiler`).value("dotty-interfaces")
+ val otherDeps = (dependencyClasspath in Compile).value.map(_.data).mkString(File.pathSeparator)
+ dottyLib + File.pathSeparator + dottyInterfaces + File.pathSeparator + otherDeps
+ }
+
// Settings shared between dotty-doc and dotty-doc-bootstrapped
lazy val dottyDocSettings = Seq(
baseDirectory in (Compile, run) := baseDirectory.value / "..",
@@ -364,9 +371,6 @@ object Build {
val majorVersion = baseVersion.take(baseVersion.lastIndexOf('.'))
IO.write(file("./docs/_site/versions/latest-nightly-base"), majorVersion)
- val dottyLib = (packageAll in `dotty-compiler`).value("dotty-library")
- val dottyInterfaces = (packageAll in `dotty-compiler`).value("dotty-interfaces")
- val otherDeps = (dependencyClasspath in Compile).value.map(_.data).mkString(":")
val sources =
(unmanagedSources in (Compile, compile)).value ++
(unmanagedSources in (`dotty-compiler`, Compile)).value
@@ -375,7 +379,7 @@ object Build {
"-project", "Dotty",
"-project-version", dottyVersion,
"-project-url", dottyGithubUrl,
- "-classpath", s"$dottyLib:$dottyInterfaces:$otherDeps"
+ "-classpath", dottydocClasspath.value
)
(runMain in Compile).toTask(
s""" dotty.tools.dottydoc.Main ${args.mkString(" ")} ${sources.mkString(" ")}"""
@@ -384,10 +388,7 @@ object Build {
dottydoc := Def.inputTaskDyn {
val args: Seq[String] = spaceDelimited("<arg>").parsed
- val dottyLib = (packageAll in `dotty-compiler`).value("dotty-library")
- val dottyInterfaces = (packageAll in `dotty-compiler`).value("dotty-interfaces")
- val otherDeps = (dependencyClasspath in Compile).value.map(_.data).mkString(":")
- val cp: Seq[String] = Seq("-classpath", s"$dottyLib:$dottyInterfaces:$otherDeps")
+ val cp: Seq[String] = Seq("-classpath",dottydocClasspath.value)
(runMain in Compile).toTask(s""" dotty.tools.dottydoc.Main ${cp.mkString(" ")} """ + args.mkString(" "))
}.evaluated, |
- use File.pathSeparator instead of hard-coded path separator `:`
=> this way Windows user can run the command as well
- reduce code duplication: move classpath string generation to
own task and reuse it in genDocs and dottydocs
robstoll
force-pushed
the
genDocs-path-separator
branch
from
4e1042d to
655a80c
Compare
|
I have rebased the branch and made the improvement accordingly |
allanrenucci
approved these changes
Mar 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
:in genDocs => this way Windows user can run the command as well